home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Internet / WWW / Perl_WWW_Utilities / MHonArc / README.DOS < prev    next >
Encoding:
Text File  |  1996-04-17  |  6.6 KB  |  170 lines
  1. README for MHonArc
  2. v1.2.2
  3.  
  4.     <URL:http://www.oac.uci.edu/indiv/ehood/mhonarc.html>
  5.  
  6. ---------------------------------------------------------------------------
  7. Table of Contents:
  8.         CONTENTS
  9.         DOCUMENTATION
  10.         INSTALLATION
  11.     MAILING LIST
  12.         BUGS/COMMENTS/SUGGESTIONS?
  13.  
  14. ---------------------------------------------------------------------------
  15.     MHonArc -- Internet mail-to-HTML converter
  16.     Copyright (C) 1995,1996    Earl Hood, ehood@convex.com
  17.  
  18.     This program is free software; you can redistribute it and/or modify
  19.     it under the terms of the GNU General Public License as published by
  20.     the Free Software Foundation; either version 2 of the License, or
  21.     (at your option) any later version.
  22.  
  23.     This program is distributed in the hope that it will be useful,
  24.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  25.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26.     GNU General Public License for more details.
  27.  
  28.     You should have received a copy of the GNU General Public License
  29.     along with this program; if not, write to the Free Software
  30.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  31. ---------------------------------------------------------------------------
  32. CONTENTS
  33.  
  34. ACKNOWLG      Thanks to people
  35. CHANGES          Revision history of MHonArc
  36. COPYING          GNU General Public License
  37. README          The file you are reading
  38. README.DOS      MS-DOS equivalent to README
  39. RELNOTES      Release notes for MHonArc
  40. bat/          Batch files for MS-DOS users
  41. doc/          Documentation for MHonArc
  42. examples/      Example resource files for MHonArc
  43. extras/          Extra programs for use with MHonArc (See extras/README)
  44. install.cfg      Base installation configuration file
  45. install.me      Installation program for MHonArc
  46. lib/          Libraries/MIME filters used by MHonArc
  47. logo/          Gifs of the MHonArc logo
  48. mhonarc*      The MHonArc program
  49.  
  50. ---------------------------------------------------------------------------
  51. DOCUMENTATION
  52.  
  53. Documentation for MHonArc is located in the doc/ directory.
  54.  
  55. html:
  56.     The main documentation for MHonArc is in multiple HTML files.  Load
  57.     mhonarc.html in the doc/ directory into your Web browser to get
  58.     started.  The HTML is generated from the Frame source via
  59.     MifMucker,
  60.     <URL:http://www.oac.uci.edu/indiv/ehood/mifmucker.doc.html>.
  61.  
  62. postscript:
  63.     The postscript file, mhonarc.ps, is available if a hardcopy version
  64.     of the documentation is required.  Since the cross-references used
  65.     are designed for HTML reading (ie they get converted into
  66.     hyperlinks), they may not be as useful for hardcopy reading.
  67.     The postscript is generated from the Frame source.
  68.  
  69. ascii:
  70.     A plain text version of the documentation is in the single file
  71.     mhonarc.txt.  This file is created by converting the HTML files
  72.     into ascii.  See the Makefile in doc/ for how the conversion is
  73.     done.
  74.  
  75. manpage:
  76.     For Unix users, there is a manpage in doc/ called mhonarc.1.  It
  77.     is not very fancy.  It is automatically generated like the
  78.     ascii version.  The manpage does not follow the standard manpage
  79.     style and is not intended to be printed via troff.
  80.  
  81. The installation process does not deal with the manpage or postscript
  82. file.  If you want to install them, you must do it manually.  The
  83. installation process does allow you to install the HTML and ASCII
  84. documentation in a location of your choice.
  85.  
  86. ---------------------------------------------------------------------------
  87. INSTALLATION
  88.  
  89. The documentation contains a section on installing MHonArc for Unix
  90. and MS-DOS machines.  I recommend reading the Installation section as
  91. it contains more information then what is included here.
  92.  
  93. Brief Instructions
  94.  
  95.     Interactive Installing:
  96.  
  97.     Run the following command:
  98.  
  99.         perl install.me
  100.  
  101.     The installation program will ask you a series of questions on
  102.     where the Perl executable is and where to put MHonArc files.
  103.     Just hit <CR> to accept the default values listed in ()'s.
  104.  
  105.     Batch Install:
  106.  
  107.     1. Edit the file 'install.cfg'.
  108.     2. Run the following command:
  109.  
  110.         perl install.me install.cfg
  111.  
  112.     The installation program will output information on what
  113.     is being installed and where it is being installed.
  114.  
  115. Notes on Installation Program
  116.  
  117.     o The '#!' line in the installed mhonarc program is set to
  118.       point to the Perl executable specified in the installation
  119.       process (this has no meaning under MS-DOS).
  120.  
  121.     o The installed mhonarc program has code added so it will find
  122.       its default libraries specified in the installation program.
  123.       I.e.  The install lib directory is added to mhonarc's search
  124.       path so it will find its libraries.
  125.  
  126.     o If you specify paths that do not exist, the install.me
  127.       program will create the path ONLY if running in interactive
  128.       more.  If using a configuration file (eg: install.cfg) you
  129.       must check that all paths specified exist.
  130.  
  131. ---------------------------------------------------------------------------
  132. MAILING LIST
  133.  
  134.     A MHonArc mailing list exists to provide a general discussion forum
  135.     for users and developers.  To subscribe to the mailing list, send
  136.     mail to mhonarc-request@rosat.mpe-garching.mpg.de with the single
  137.     word "subscribe" (without the quotes) as the message body.
  138.  
  139.     Mail sent to mhonarc@rosat.mpe-garching.mpg.de will be distributed
  140.     to all subscribers.
  141.  
  142.     The WWW archive of the mailing list is located at
  143.     <URL:http://www.rosat.mpe-garching.mpg.de/mailing-lists/mhonarc/>
  144.  
  145. ---------------------------------------------------------------------------
  146. BUGS/COMMENTS/SUGGESTIONS?
  147.  
  148.     If you have any bugs/comments/suggestions about MHonArc, you may
  149.     send mail to the proper person(s) listed in the Contacts section of
  150.     the documentation, or (the prefered method) you may send mail to
  151.     the MHonArc mailing list, mhonarc@rosat.mpe-garching.mpg.de.
  152.  
  153.     If it is a bug you are reporting, please include the following in
  154.     your message:
  155.  
  156.         o  Version of Perl (can be retrievied by "perl -v").
  157.         o  Version of the program in question.
  158.         o  The exact command-line used to invoke the program.
  159.         o  Error/diagnostic messages from the program.
  160.         o  Any other information that might prove useful.
  161.  
  162.     Before sending e-mail, make sure the documentation does not already
  163.     have an answer to your question/problem.
  164.  
  165.     The latest information on MHonArc may be obtained at
  166.     <URL:http://www.oac.uci.edu/indiv/ehood/mhonarc.html>
  167.  
  168. ---------------------------------------------------------------------------
  169. Earl Hood, ehood@convex.com
  170.